home *** CD-ROM | disk | FTP | other *** search
/ Freaks Macintosh Archive / Freaks Macintosh Archive.bin / Freaks Macintosh Archives / PC / KRCRS12.ZIP / README.TXT < prev   
Text File  |  1997-08-25  |  11KB  |  303 lines
  1.  
  2.             KRACARS v1.2
  3.             Copyright (c) 1997 Khalid Rafiq
  4.  
  5.             Release date 25 August 1997
  6.             Email kr@tardis.ed.ac.uk
  7.  
  8. DESCRIPTION:
  9. ------------
  10.  
  11. KRACARS.EXE is an ACARS decoder for the PC which attempts to decode
  12. ACARS transmissions in real-time using a Sound Blaster Pro or Sound
  13. Blaster 16 (or compatible) soundcard.
  14.  
  15. Although there is no warranty provided with KRACARS, I would welcome any
  16. comments, problem reports and other feedback you may have concerning
  17. this software.
  18.  
  19. You can contact me by email kr@tardis.ed.ac.uk.
  20.  
  21.  
  22. REQUIREMENTS:
  23. -------------
  24.  
  25. 1. PC with at least 1Mbyte RAM, minimum CPU requirement unknown,
  26. 2. DOS, minimum version unknown,
  27. 3. SoundBlaster PRO or SoundBlaster 16 (or compatibles),
  28. 4. Radio receiver with audio cable for connection to soundcard,
  29.  
  30. KRACARS will also work from within Windows 95 as a DOS application.
  31.  
  32.  
  33. LICENSE:
  34. --------
  35.  
  36. KRACARS is FREEWARE. This software may be freely copied and distributed
  37. providing that the program and accompanying files are not modified in
  38. any way without prior written permission of the author. Any charges made
  39. for distributing this software may not exceed that of the cost of the
  40. distribution media. You are granted a license to use this software
  41. providing you accept the disclaimer below.
  42.  
  43.  
  44. DISCLAIMER:
  45. -----------
  46.  
  47. Although this product has been tested by the author, he accepts no
  48. responsibility for any damages caused by the use or misuse of this
  49. software. This software is distributed 'as is' with no warranty
  50. expressed or implied. The author will not be responsible for any losses
  51. incurred, either directly or indirectly, by the use of this software.
  52. Use this software entirely at your own risk. If you do not agree to
  53. these terms then you must not use this software.
  54.  
  55.  
  56. INSTRUCTIONS:
  57. -------------
  58.  
  59. 1. Before using KRACARS it is recommended that you:-
  60. (a) scan KRACARS.EXE with a virus checker
  61. (b) backup your file systems
  62.  
  63. 2. Make sure that the BLASTER environment variable is set to match the
  64. settings of your soundcard (Eg. BLASTER=A220 I5 D1). This program does
  65. not support the use of IRQs greater than 7.
  66.  
  67. 3. Use the mixer utility provided with your soundcard to adjust the
  68. line-in level. It is recommended that you enable monitoring of the
  69. line-in audio signal (if your soundcard and mixer utility allow this).
  70. If you have a microphone connected to your soundcard, you may wish to
  71. either disconnect it or set the microphone level to zero. If your
  72. soundcard's line-in input has an AGC feature, this should probably be
  73. disabled too.
  74.  
  75. 4. Connect your radio receiver to the soundcard line-in socket via a
  76. suitable audio lead and adjust the receiver volume. Note that you should
  77. leave the receiver SQUELCH control open. Tune your receiver to the ACARS
  78. transmission frequency in use in your area (I use the European Primary
  79. ACARS Frequency of 131.725 MHz AM).
  80.  
  81. Some ACARS frequencies (in MHz AM) are:-
  82.  
  83. 131.725 European Primary
  84. 131.525 European Secondary
  85. 131.550 USA, Australia, New Zealand
  86. 131.450 Japan
  87. 129.125 USA Secondary
  88. 130.025 USA Secondary
  89. 131.475 Canadian (Company)
  90.  
  91. 5. Type KRACARS at the DOS prompt. You can optionally specify the
  92. following command line parameters:
  93.  
  94.     -d    Use date derived filenames for the raw and log files
  95.         (ie. YYYYMMDD.LOG and YYYYMMDD.RAW instead of
  96.         KRACARS.LOG and KRACARS.RAW).
  97.     -o    Overwrite rather than append to the raw and log files
  98.         (default is to append).
  99.     -a    Write a DACARS compatible log file (default is to use
  100.         KRACARS own format).
  101.     ?    Display command line options summary.
  102.  
  103. 6. If all is well, you will see a program banner displayed at the top of
  104. the screen. A rotating character with be seen at the bottom of the
  105. screen along with an S-METER displaying audio signal strength. If your
  106. CPU is too slow to process the sampled input in real time, the SLOW
  107. counter displayed at the bottom of the screen will increment. If your
  108. hard disk is too slow, then you will see this counter increment during
  109. logging.
  110.  
  111. The TIME value at the bottom of the screen displays the processing time
  112. required to process a fixed number of input samples. The slower your
  113. CPU, the larger this value. This value will increase during logging to
  114. disk.
  115.  
  116. If you see the SLOW counter increment, you are probably not going to get
  117. reliable decoding results. I am interested to hear from you if this
  118. happens on your PC. Please send me an email with a note of your CPU type
  119. and the approximate TIME value (displayed at the bottom of the screen).
  120.  
  121. 7. Adjust the volume control of the receiver or the soundcard line-in
  122. mixer control (you will need to use trial and error) to the value which
  123. best suits your setup. The S-METER at the bottom of the screen can be
  124. used for this purpose. This meter indicates the audio signal strength
  125. being sampled at the input to the soundcard. I have found that an
  126. S-meter reading of around 10 when sampling receiver hiss (no RF signal
  127. and with SQUELCH open) provides ample signal for decoding ACARS
  128. transmissions.
  129.  
  130. 8. Wait for ACARS transmissions to occur. Decoded transmissions will be
  131. displayed on the screen and logged to the files KRACARS.RAW and
  132. KRACARS.LOG (or YYYYMMDD.RAW and YYYYMMDD.LOG if -d was specified) in
  133. the current directory as described in the OPERATION section.
  134.  
  135. 9. To quit KRACARS, press a key on the keyboard. KRACARS will perform an
  136. orderly shutdown sequence (which may take a few seconds) and return you
  137. to the DOS prompt.
  138.  
  139.  
  140. OPERATION:
  141. ----------
  142.  
  143. Once KRACARS is up and running, it will display all ACARS messages on
  144. the screen in raw format and will write these messages into the raw
  145. output file. Non-printables (ASCII 0 to 31 & 127) will be expanded as
  146. below:
  147.  
  148. 0=<NUL>        1=<SOH>        2=<STX>        3=<ETX>
  149. 4=<EOT>        5=<ENQ>        6=<ACK>        7=<BEL>
  150. 8=<BS>        9=<HT>        10=<LF>        11=<VT>
  151. 12=<FF>        13=<CR>        14=<SO>        15=<SI>
  152. 16=<DLE>    17=<DC1>    18=<DC2>    19=<DC3>
  153. 20=<DC4>    21=<NAK>    22=<SYN>    23=<ETB>
  154. 24=<CAN>    25=<EM>        26=<SUB>    27=<ESC>
  155. 28=<FS>        29=<GS>        30=<RS>        31=<US>
  156. 127=<DEL>
  157.  
  158. Characters received with parity errors will be displayed in red while
  159. those received without error are displayed in white.
  160.  
  161. Raw ACARS data is then checked to determine if the message data can be
  162. interpreted correctly. If so the message will be redisplayed with
  163. message headers otherwise a failure code will be displayed.
  164.  
  165. The failure codes for the current software release are as follows:
  166.  
  167. 1= Problem with message preamble *<SYN><SYN><SOH>
  168. 2= Problem with mode, address, label and block id (if present)
  169. 3= [unimplemented failure code]
  170. 4= Parity error with <STX> marker when block id is present
  171. 5= Problem with location or presence of <STX> marker
  172. 6= Problem with sequence number or flight number
  173. 7= Parity error in message text
  174. 8= Problem with <ETX> or <ETB> marker
  175.  
  176. An example of a raw and interpreted ACARS message is shown below:
  177.  
  178. [23/06/1997 21:57:55]
  179. *<SYN><SYN><SOH>U.C-GDSU<NAK>4P<STX>0008AC0859Q119A124U2//<ETX>E<DEL><DEL>
  180.  
  181. [23/06/1997 21:57]
  182. ACARS mode: U Aircraft reg: .C-GDSU
  183. Message label: 4P Block id: ? Msg. no: 0008
  184. Flight id: AC0859
  185. Message content:-
  186. Q119A124U2//
  187.  
  188. The block id is shown as a question mark if this field was not present
  189. in the message.
  190.  
  191. The message content field is not shown if this field was not present.
  192.  
  193. The GOOD and BAD message counters are incremented appropriately for each
  194. message received.
  195.  
  196.  
  197. IMPROVEMENTS:
  198. -------------
  199.  
  200. Feel free to email me with improvements you would like to see in
  201. KRACARS. Note that I'm not promising anything here!
  202.  
  203. 1. There is probably scope for further improving the signal detection
  204. algorithm which seems to be susceptable to noisy signals. I would be
  205. interested to hear from users who have made receive performance
  206. comparisons between KRACARS and some of the other commercial ACARS
  207. decoders.
  208.  
  209. 2. KRACARS does not perform Block Sequence Checking on the received
  210. ACARS data (only parity checking is performed). This may be added to a
  211. later release.
  212.  
  213. 3. The user interface is currently limited to 'press any key to exit'.
  214.  
  215. 4. The addition of mixer controls would be a handy feature. Currently
  216. the user is required to quit KRACARS and invoke a soundcard mixer
  217. utility to adjust the soundcard's input level control.
  218.  
  219. 5. KRACARS requires a soundcard which can support a sample rate of 21739
  220. Hz. This is due to the method used to detect the 1200/2400Hz tones
  221. present in ACARS transmission. It should however be possible to use more
  222. advanced techniques (such as FFT) to extract the tones from the sampled
  223. signal, allowing the use of slower sample rates and Sound Blaster 1.5 &
  224. 2 (and compatible) soundcards.
  225.  
  226. 6. Further code optimisations - although this seems to be not necessary.
  227.  
  228. 7. More intelligent decoding of ACARS messages. Removing duplicated
  229. messages. On screen summary of aircraft registrations logged.
  230.  
  231.  
  232. RELEASE HISTORY:
  233. ----------------
  234.  
  235. v1.0b - 24 June 1997:
  236.     Initial release of KRACARS
  237.  
  238. v1.1b - 18 August 1997:
  239.     Fixed DMA buffer allocation bug which caused unreliable
  240.     operation and in some cases machine crashes.
  241.  
  242.     Added -d -o -a command line parameters.
  243.  
  244.     KRACARS will now append to RAW and LOG files by default (-o
  245.     option overwrites).
  246.  
  247.     Added DACARS compatibility to file logging via -a option.
  248.  
  249.     Added date derived filenames feature for log files via the -d
  250.     option.
  251.  
  252.     Reduced sample rate from 22050 to 21739 Hz to improve tone
  253.     detection algorithm.
  254.  
  255.     Fixed bug which caused the block id field to be displayed
  256.     incorrectly.
  257.  
  258.     Changed the way the signal level is reported on the status line.
  259.     A digital display replaces the analogue level meter.
  260.  
  261.     Reduced the number of samples used to calculate the signal level
  262.     by a factor of 16. This should reduce the amount of CPU usage
  263.     required for KRACARS.
  264.  
  265.     Corrected bug which caused the message 'Error: Blaster variable
  266.     is not set' to disappear before the user could see it.
  267.  
  268. v1.2 -    25 August 1997:
  269.     Improved signal detection algorithm significantly. The algorithm
  270.     requires more CPU than before, but seems to give much better
  271.     decoding performance.
  272.  
  273.     Added code to allow KRACARS to multi-task more efficiently when
  274.     being used from Win95.
  275.  
  276.  
  277. ACKNOWLEDGEMENTS:
  278. -----------------
  279.  
  280. Development of KRACARS would not have been possible without the kind
  281. assistance of the following people (please send me an email if I've
  282. missed you out):
  283.  
  284. Robert Evans
  285. Edward Flynn
  286. Bart Hoekstra
  287. Michael Hooker
  288. Frank Mackowick
  289.  
  290. and off course all you testers out there!
  291.  
  292. In addition KRACARS contains timer routines placed in the public
  293. domain by the following people:
  294.  
  295. David Kirschbaum
  296. Dean Pentcheff
  297. Fred Smith
  298.  
  299. --
  300. Well folks, have fun experimenting and keep those emails coming in :)
  301. Regards,
  302. Khalid Rafiq.
  303.